<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Maven Overview Plugin - Maven Overview Plugin - Usage</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
          <meta name="author" content="Hubert Iwaniuk" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Maven Overview Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2009-07-08
                      </div>
            <div class="xright">            <a href="http://github.com/neotyk/maven-overview-plugin/tree/master" class="externalLink">Source Tree</a>
            |
                <a href="">Maven Overview Plugin</a>
            |
                <a href="http://maven.apache.org/" class="externalLink">Maven 2</a>
            
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
              
    <li class="none">
              <strong>Usage</strong>
        </li>
              
    <li class="none">
                    <a href="faq.html">FAQ</a>
          </li>
          </ul>
              <h5>Examples</h5>
            <ul>
              
    <li class="none">
                    <a href="examples/report.html">Report</a>
          </li>
              
    <li class="none">
                    <a href="examples/command.html">CommandLine</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2>Introduction</h2>
<p>This page describes how to install maven-overview-plugin.</p>
</div>
<div class="section"><h2>Details</h2>
<p>maven-overview-plugin is available from [http://repo1.maven.org/maven2/ Maven Central Repository].</p>
</div>
<div class="section"><h2>Usage</h2>
<div class="section"><h3>As report</h3>
<p>Add following to you pom.xml</p>
<div class="source"><pre>  &lt;reporting&gt;
    &lt;plugins&gt;
      ...
      &lt;plugin&gt;
        &lt;groupId&gt;com.googlecode.maven-overview-plugin&lt;/groupId&gt;
        &lt;artifactId&gt;maven-overview-plugin&lt;/artifactId&gt;
        &lt;version&gt;RELEASE&lt;/version&gt;
      &lt;/plugin&gt;
    &lt;/plugins&gt;
  &lt;/reporting&gt;</pre>
</div>
</div>
<div class="section"><h3>Standalone</h3>
<p>Execute following</p>
<div class="source"><pre>mvn com.googlecode.maven-overview-plugin:maven-overview-plugin:RELEASE:overview</pre>
</div>
<p>Overview graph will be generated in target/site/images/overview.png</p>
</div>
<div class="section"><h3>Legend</h3>
<p>The color indicates the dependency distance. The artifact for which the diagram is created is rendered as a red dot. Direct dependencies are rendered orange. Brightness will increase if you start moving to the edges of the dependency graph.</p>
</div>
<div class="section"><h3>Filtering</h3>
<p>There are several options for filtering undesired dependencies. Check out the <a href="overview-mojo.html">available configuration options</a> for the details, or <a href="examples/report.html">the examples</a> for how to configure the plugin.</p>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2008-2009
    
          Agile Java
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
